Esx Settings TaskInfo
The Esx Settings TaskInfo schema contains information about a task and its subtasks of which it consists.
This schema was added in vSphere API 7.0.0.0.
{
"progress": {
"total": 0,
"completed": 0,
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
}
},
"subtasks": {
"subtasks": "Esx Settings TaskInfo Object"
},
"subtask_summaries": {
"subtask_summaries": [
{
"id": "string"
}
]
},
"notifications": {
"info": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"warnings": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
],
"errors": [
{
"type": "string",
"id": "string",
"time": "string",
"message": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"resolution": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"originator": "string",
"retriable": false
}
]
},
"last_update_time": "string",
"description": {
"id": "string",
"default_message": "string",
"args": [
"string"
],
"params": {
"params": {
"s": "string",
"dt": "string",
"i": 0,
"d": "number",
"l": "Vapi Std NestedLocalizableMessage Object",
"format": "string",
"precision": 0
}
},
"localized": "string"
},
"service": "string",
"operation": "string",
"parent": "string",
"target": {
"type": "string",
"id": "string"
},
"status": "string",
"cancelable": false,
"error": {},
"start_time": "string",
"end_time": "string",
"user": "string"
}Progress of the operation.
This property was added in vSphere API 7.0.0.0.
This property is optional and it is only relevant when the value of CommonInfo#status is one of Cis Task Status.RUNNING, Cis Task Status.BLOCKED, Cis Task Status.SUCCEEDED, or Cis Task Status.FAILED.
Information about the subtasks that this task contains.
This property was added in vSphere API 7.0.0.0.
This property will be missing or null if the task has no subtasks. This property will be missing or null if the task is a bulk operation.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: com.vmware.cis.task.
Summary about the subtasks for each entity if the current task is a bulk operation. The map is null or empty if the current task is not a bulk operation.
This property was added in vSphere API 9.0.0.0.
This property is optional because it was added in a newer version than its parent node.
When clients pass a value of this schema as a parameter, the key in the property map must be an identifier for the resource type: ManagedEntity. When operations return a value of this schema as a response, the key in the property map will be an identifier for the resource type: ManagedEntity.
Notifications to the user
This property was added in vSphere API 7.0.0.0.
Only set if the notifications were reported by this particular task.
Task result.
This property was added in vSphere API 7.0.0.0.
This property will be missing or null if the task has no result.
Time when the task was last updated
This property was added in vSphere API 7.0.1.0.
This property is optional because it was added in a newer version than its parent node.
Description of the operation associated with the task.
This property was added in vSphere API 6.7.
Identifier of the service containing the operation.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.service. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.service.
Identifier of the operation associated with the task.
This property was added in vSphere API 6.7.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.vapi.operation. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.vapi.operation.
Parent of the current task.
This property was added in vSphere API 6.7.
This property will be missing or null if the task has no parent.
When clients pass a value of this schema as a parameter, the property must be an identifier for the resource type: com.vmware.cis.task. When operations return a value of this schema as a response, the property will be an identifier for the resource type: com.vmware.cis.task.
Identifier of the target created by the operation or an existing one the operation performed on.
This property was added in vSphere API 6.7.
This property will be missing or null if the operation has no target or multiple targets.
Status of the operation associated with the task.
For more information see: Cis Task Status.
This property was added in vSphere API 6.7.
Flag to indicate whether or not the operation can be cancelled. The value may change as the operation progresses.
This property was added in vSphere API 6.7.
Description of the error if the operation status is "FAILED".
This property was added in vSphere API 6.7.
If missing or null the description of why the operation failed will be included in the result of the operation (see Cis Task Info.result).
Time when the operation is started.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Cis Task Status.RUNNING, Cis Task Status.BLOCKED, Cis Task Status.SUCCEEDED, or Cis Task Status.FAILED.
Time when the operation is completed.
This property was added in vSphere API 6.7.
This property is optional and it is only relevant when the value of status is one of Cis Task Status.SUCCEEDED or Cis Task Status.FAILED.
Name of the user who performed the operation.
This property was added in vSphere API 6.7.
This property will be missing or null if the operation is performed by the system.